XFBTRANSFER Sentinel Tracked Object

EBICS Server generates and sends an XFBTransfer notification message to Sentinel each time a message it is processing has a change in transfer state.

Transfer states

Fetch transfer states

State	Description
FAILED	This may be the first event of the transfer if the transfer is rejected by the Server. This may occur, for example, if the Transfer Request has an invalid signature, or the EBICS User is unknown by the Server. In this case, the RETURNCODE and RETURNMESSAGE contain the standard EBICS value. Some attributes may be missing in Sentinel if missing parameters are the cause of the failure, or if a failure interrupts the complete collection of parameters.
TO_EXECUTE	The transfer has been accepted by the Server and will start immediately. All parameters have been checked and are available in Sentinel.
SENT	The transfer is complete and the data has been sent to the EBICS Client.

State

Description

FAILED

This may be the first event of the transfer if the transfer is rejected by the Server. This may occur, for example, if the Transfer Request has an invalid signature, or the EBICS User is unknown by the Server. In this case, the RETURNCODE and RETURNMESSAGE contain the standard EBICS value.

Some attributes may be missing in Sentinel if missing parameters are the cause of the failure, or if a failure interrupts the complete collection of parameters.

TO_EXECUTE

The transfer has been accepted by the Server and will start immediately. All parameters have been checked and are available in Sentinel.

SENT

The transfer is complete and the data has been sent to the EBICS Client.

Send transfer states

On client Sends, tracking goes beyond the EBICS Server events. It includes the transfer up to the back-end application.

State	Description
FAILED	This may be the first event of the transfer, if the transfer is rejected by the Server. This may occur, for example, if the Transfer Request has an invalid signature, or the EBICS User is unknown by the Server. In this case, the RETURNCODE and RETURNMESSAGE contain the standard EBICS value. Some attributes may be missing in Sentinel if missing parameters are the cause of the failure, or if a failure interrupts the complete collection of parameters.
TO_EXECUTE	The transfer has been accepted by the Server and will start immediately. Most of the parameters have been checked and are available in Sentinel.
RECEIVED	The transfer has been completed and the data is available for further processing by the EBICS Server. Depending upon Server configuration, the next step might be VEU processing, post-processing or DFile handling.
ROUTED	The data is transferred via post-processing to the back-end applications. This can be a JMS bridge, a Gateway transfer or a custom process.
ROUTE_FAILED	Post-processing has failed, and requires a technical intervention.
COPIED	This state is sent during the post-processing. When the data file has been copied or when the proof file has been written, a notification is sent to Sentinel. The attribute RETURNMESSAGE contains the full path name of the file.
ENDED_TO_ACK	For a DFile, when a manual release is required. The EBICS Server is waiting for a manual acknowledgement from the EBICS Server operator.
ACK_USER	For a DFile, the EBICS Server operator has validated the transfer. This transfer is forwarded to a back-end application.
NACK_USER	For a DFile, the EBICS Server operator has not validated the transfer. This transfer is held on the EBICS Server and is not forwarded to the back-end application.
WAIT_FOR_SIGN	For VEU handling, the EBICS Server has detected that additional signatures were needed to accept the transfer. Meanwhile, the data is stored internally on the EBICS Server and not available for the back-end application.
SIGNATURE_ADDED	Either a new signature has arrived independently of the initial transfer (VEU), or several signatures are embedded within the same transfer. In both cases, for each new signature, a new Sentinel notification with status SIGNATURE_ADDED is generated. The SUSER attribute contains the Signer name.
NACK_SIGNATURE	For VEU handling, the EBICS Server has received a new (disagreement) signature for the transfer. The transfer is canceled.

XFBTransfer attributes

Attribute Name	Description
CREATIONDATE	Creation date
CREATIONTIME	Creation time
CUSTOMERID
CYCLEID	Identifier of the Tracked Event, in this case, the message handling on the EBICS Server.
DIRECTION	Fetch: E (Emission) Send: R (Reception)
ENDDATE	Processing end date. Set to the date when state is received, empty otherwise
ENDTIME	Processing end time. Set to the time when state is received, empty otherwise.
EOTPROCEDURE	Name of the Send script
EVENTDATE	Date of the generation of the event (DD/MM/YYY)
EVENTTIME	Time of the generation of the event (hh:mm:ss)
FILENAME	Complete path to the file received by the Bank (Attention: this value can be subsequently removed from the system.
FILESIZE	Size of the file in bytes.
ISALERT	1 = error
ISEND	Accepts the values: 0: The message handling is not complete 1 or 2: The message handling is complete
ISEXCEPTION	1 = error
LOCATION	Local identifier of the EBICS Server. This value is the EbicsLocalSite attribute value that is defined in configuration.properties. If the EBICS Server does not locate this value, the value defaults to the hostname of the EBICS Server configuration.
MACHINE	Type of platform. Possible values: EBICS-UNIX EBICS-NT
MONITOR	EBCS
MONITORVERSION	FEX version Example: 2.9.0
ORIGINALSENDERID	SystemID if used on the transfer.
POSITION NUMBER	Order Number for the send transfer
PRODUCTNAME	Name of the product generating the event
PROTOCOL	EBICS
PROTOCOLID	Value of the Protocol version/revision. For example, H003.1.
PROTOCOLPARAMETER	Send: No value Fetch: "From=yyyy-mm-dd To=yyyy-mm-dd"
RAPPL	Customer name in the <name1> parameter in the UI
RECEIVERID	Send: bankHostId Fetch: userId
RETURNCODE	Value of the EBICS code returned by the EBICS Server. 000000 = OK
RETURNMESSAGE	Label returned by the EBICS Server
SAPPL	User name in the <name2> parameter in the UI
SENDATE	Send date
SENDERID	Send: userId Fetch: bankHostId
SENDTIME	Send time
SIGNENTITYOBJECTID	Reserved for future use
SIGNENTITYOBJECTTYPE	Reserved for future use
STARTDATE	Processing start date
STARTTIME	Processing start time
STATE	State of the message handing.
SUSER	User name of one of the signers of the transfer. Note: You cannot find the SystemID inside the SUSER. It is stored inside the attribute OriginalSenderId.
TRADEDESTINATION	Send: bankHostID Fetch: customerId
TRADEORIGINATOR	Send: customerId Fetch: bankHostId
TRADEREQUESTTYPE	FileFormat Example: pain.001.001.02.mct
TRADESERVICE	OrderType (3 characters)
TRANSFERTYPE	Set to "T" if it is a test message. (Sent for orderType FUL.* only)